home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / system / shells / guest-0.000 / guest-0 / guest-0.2 / README < prev    next >
Text File  |  1995-05-08  |  3KB  |  57 lines
  1. NOTE: I don't like the name `guest', but I have been unable to come up with
  2. anything else. Any takers? Also, the version number (0.1) is low because I
  3. have been the only person to test it, not because it's very buggy; as I get
  4. feedback the number is likely to be bumped up.
  5.  
  6. What is `guest'?
  7.     Guest is a Unix/ncurses menu interface. I originally wrote
  8.     it when I tried to make a shell script to add some security to my
  9.     guest account. I found that shell scripts are completely impossible to
  10.     write in a decent way and just plain ugly to look at. So I had my hand
  11.     at writing my own. Besides, I wanted to try out my gnu-ELF build
  12.     environment on something other than one module programs.
  13.  
  14. How do I write menus?
  15.     Guest menus are very simple to write and read. They are laid out in a
  16.     very logical way much like the menus to `fvwm' (1.xx anyway).
  17.     Unfortunately, at this point the parser is a bit crude and is a
  18.     stickler for things like case, but it has nice verbose output so you
  19.     can trace down the problem in the menu file really easily.
  20.  
  21.     A menu starts with the word `Menu' followed by the menu name (not the
  22.     title), and ends with the word `EndMenu'. Each menu consists of a
  23.     variety of tokens and there respective arguments, tokens and arguments
  24.     are split by the character `:'. At this point there is no escape
  25.     character, so you cannot use `:' in menu text. Every token has at
  26.     least one argument, which is what will appear on the screen.
  27.  
  28.     The tokens currently recognized by guest are as follows:
  29.         * `Title': denotes the title of the menu (you can have as many
  30.           as you like).
  31.             Title:Main Menu:
  32.         * `Exec': denotes an executable item and has two arguments,
  33.           the second is the command line to execute.
  34.             Exec:Read Mail:pine:
  35.         * `SubMenu': denotes a link to another menu and has two
  36.           arguments, the second is the name of the Menu to link to.
  37.             SubMenu:File Utilities:File-Util:
  38.         * `Exit': quits the current menu, if the current menu is the
  39.           first menu, you will be logged out.
  40.             Exit:Logout:
  41.         * `Nop': is for comments
  42.             Nop:This is a comment:
  43.  
  44. Putting it together:
  45.     Please see the file `test.menu' for a complete menu. Then try:
  46.  
  47.     guest test.menu
  48.  
  49. HOW TO GET HELP:
  50.     Send all patches/advice/questions/flames to
  51.     `shmit@meathook.intac.com' I hope you find this software useful, and
  52.     please: hack away at the code, add new screen modules, take some items
  53.     off the TODO list. The only thing I ask is that you send me patches
  54.     (with comments) when you have done something.
  55.  
  56.     Or just talk to a good shrink.
  57.